home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
u_man
/
cat3
/
Tk
/
menubutton.z
/
menubutton
Wrap
Text File
|
1998-10-30
|
15KB
|
265 lines
mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk)))) mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))
NNNNAAAAMMMMEEEE
menubutton - Create and manipulate menubutton widgets
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd ccccuuuurrrrssssoooorrrr hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss ttttaaaakkkkeeeeFFFFooooccccuuuussss |
aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd iiiimmmmaaaaggggeeee tttteeeexxxxtttt |
aaaannnncccchhhhoooorrrr ffffoooonnnntttt jjjjuuuussssttttiiiiffffyyyy tttteeeexxxxttttVVVVaaaarrrriiiiaaaabbbblllleeee |
bbbbaaaacccckkkkggggrrrroooouuuunnnndddd ffffoooorrrreeeeggggrrrroooouuuunnnndddd ppppaaaaddddXXXX uuuunnnnddddeeeerrrrlllliiiinnnneeee |
bbbbiiiittttmmmmaaaapppp hhhhiiiigggghhhhlllliiiigggghhhhttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd ppppaaaaddddYYYY wwwwrrrraaaappppLLLLeeeennnnggggtttthhhh |
bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh hhhhiiiigggghhhhlllliiiigggghhhhttttCCCCoooolllloooorrrr rrrreeeelllliiiieeeeffff
See the ``options'' manual entry for details on the standard options.
WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
Name: hhhheeeeiiiigggghhhhtttt
Class: HHHHeeeeiiiigggghhhhtttt
Command-Line Switch:----hhhheeeeiiiigggghhhhtttt
Specifies a desired height for the menubutton. If an image or
bitmap is being displayed in the menubutton then the value is in
screen units (i.e. any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss); for
text it is in lines of text. If this option isn't specified, the
menubutton's desired height is computed from the size of the image
or bitmap or text being displayed in it.
Name: iiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn |
Class: IIIInnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn |
Command-Line Switch:----iiiinnnnddddiiiiccccaaaattttoooorrrroooonnnn |
The value must be a proper boolean value. If it is true then a |
small indicator rectangle will be displayed on the right side of the|
menubutton and the default menu bindings will treat this as an |
option menubutton. If false then no indicator will be displayed.
Name: mmmmeeeennnnuuuu
Class: MMMMeeeennnnuuuuNNNNaaaammmmeeee
Command-Line Switch:----mmmmeeeennnnuuuu
Specifies the path name of the menu associated with this menubutton.
The menu must be a child of the menubutton.
Name: ssssttttaaaatttteeee
Class: SSSSttttaaaatttteeee
Command-Line Switch:----ssssttttaaaatttteeee
Specifies one of three states for the menubutton: nnnnoooorrrrmmmmaaaallll, aaaaccccttttiiiivvvveeee,
or ddddiiiissssaaaabbbblllleeeedddd. In normal state the menubutton is displayed using the
ffffoooorrrreeeeggggrrrroooouuuunnnndddd and bbbbaaaacccckkkkggggrrrroooouuuunnnndddd options. The active state is typically
used when the pointer is over the menubutton. In active state the
PPPPaaaaggggeeee 1111
mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk)))) mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))
menubutton is displayed using the aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd and
aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd options. Disabled state means that the menubutton |
should be insensitive: the default bindings will refuse to activate|
the widget and will ignore mouse button presses. In this state the
ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd and bbbbaaaacccckkkkggggrrrroooouuuunnnndddd options determine how the button
is displayed.
Name: wwwwiiiiddddtttthhhh
Class: WWWWiiiiddddtttthhhh
Command-Line Switch:----wwwwiiiiddddtttthhhh
Specifies a desired width for the menubutton. If an image or bitmap
is being displayed in the menubutton then the value is in screen
units (i.e. any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss); for text
it is in characters. If this option isn't specified, the
menubutton's desired width is computed from the size of the image or
bitmap or text being displayed in it.
IIIINNNNTTTTRRRROOOODDDDUUUUCCCCTTTTIIIIOOOONNNN
The mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn command creates a new window (given by the _p_a_t_h_N_a_m_e
argument) and makes it into a menubutton widget. Additional options,
described above, may be specified on the command line or in the option
database to configure aspects of the menubutton such as its colors, font,
text, and initial relief. The mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn command returns its _p_a_t_h_N_a_m_e
argument. At the time this command is invoked, there must not exist a
window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
A menubutton is a widget that displays a textual string, bitmap, or image|
and is associated with a menu widget. If text is displayed, it must all |
be in a single font, but it can occupy multiple lines on the screen (if |
it contains newlines or if wrapping occurs because of the wwwwrrrraaaappppLLLLeeeennnnggggtttthhhh |
option) and one of the characters may optionally be underlined using the |
uuuunnnnddddeeeerrrrlllliiiinnnneeee option. In normal usage, pressing mouse button 1 over the
menubutton causes the associated menu to be posted just underneath the
menubutton. If the mouse is moved over the menu before releasing the
mouse button, the button release causes the underlying menu entry to be
invoked. When the button is released, the menu is unposted.
Menubuttons are typically organized into groups called menu bars that
allow scanning: if the mouse button is pressed over one menubutton
(causing it to post its menu) and the mouse is moved over another
menubutton in the same menu bar without releasing the mouse button, then
the menu of the first menubutton is unposted and the menu of the new
menubutton is posted instead.
There are several interactions between menubuttons and menus; see the |
mmmmeeeennnnuuuu manual entry for information on various menu configurations, such as|
pulldown menus and option menus.
PPPPaaaaggggeeee 2222
mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk)))) mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))
WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
The mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e.
This command may be used to invoke various operations on the widget. It
has the following general form:
_p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
_O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command. The
following commands are possible for menubutton widgets:
_p_a_t_h_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n
Returns the current value of the configuration option given by |
_o_p_t_i_o_n. _O_p_t_i_o_n may have any of the values accepted by the |
mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn command.
_p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
Query or modify the configuration options of the widget. If no
_o_p_t_i_o_n is specified, returns a list describing all of the available
options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the
format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
the command returns a list describing the one named option (this
list will be identical to the corresponding sublist of the value
returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e
pairs are specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the command
returns an empty string. _O_p_t_i_o_n may have any of the values accepted
by the mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn command.
DDDDEEEEFFFFAAAAUUUULLLLTTTT BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
Tk automatically creates class bindings for menubuttons that give them |
the following default behavior:
[1] A menubutton activates whenever the mouse passes over it and
deactivates whenever the mouse leaves it.
[2] Pressing mouse button 1 over a menubutton posts the menubutton: its
relief changes to raised and its associated menu is posted under the
menubutton. If the mouse is dragged down into the menu with the
button still down, and if the mouse button is then released over an
entry in the menu, the menubutton is unposted and the menu entry is
invoked.
[3] If button 1 is pressed over a menubutton and then released over that
menubutton, the menubutton stays posted: you can still move the
mouse over the menu and click button 1 on an entry to invoke it.
Once a menu entry has been invoked, the menubutton unposts itself.
[4] If button 1 is pressed over a menubutton and then dragged over some
other menubutton, the original menubutton unposts itself and the new
menubutton posts.
PPPPaaaaggggeeee 3333
mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk)))) mmmmeeeennnnuuuubbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))
[5] If button 1 is pressed over a menubutton and released outside any
menubutton or menu, the menubutton unposts without invoking any menu
entry.
[6] When a menubutton is posted, its associated menu claims the input
focus to allow keyboard traversal of the menu and its submenus. See
the mmmmeeeennnnuuuu manual entry for details on these bindings.
[7] If the uuuunnnnddddeeeerrrrlllliiiinnnneeee option has been specified for a menubutton then
keyboard traversal may be used to post the menubutton: Alt+_x, where
_x is the underlined character (or its lower-case or upper-case
equivalent), may be typed in any window under the menubutton's
toplevel to post the menubutton.
[8] The F10 key may be typed in any window to post the first menubutton
under its toplevel window that isn't disabled.
[9] If a menubutton has the input focus, the space and return keys post
the menubutton.
If the menubutton's state is ddddiiiissssaaaabbbblllleeeedddd then none of the above actions
occur: the menubutton is completely non-responsive.
The behavior of menubuttons can be changed by defining new bindings for
individual widgets or by redefining the class bindings.
KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
menubutton, widget
PPPPaaaaggggeeee 4444